home *** CD-ROM | disk | FTP | other *** search
/ The Original Shareware 1.1 / The Original Shareware (WeMake CDs)(Volume 1.1)(CDs, Inc)(1993).iso / 10 / schedule.doc < prev    next >
Text File  |  1990-08-06  |  13KB  |  344 lines
  1.                       IBM/PC PROGRAM SCHEDULER
  2.                             USER'S GUIDE
  3.  
  4.  
  5.                         Copyright 1986-1990
  6.                        (All rights reserved)
  7.                 
  8.                       Real Time eXecutives, Inc.
  9.                            P. O. Box 160
  10.                           686 South Street
  11.                          Wrentham, MA  02093
  12.                         Tel:  (508) 384-7717
  13.                          MCI Mail:  431-4677
  14.  
  15.  
  16.  
  17.  
  18.  
  19. SCHEDULE.EXE is a ShareWare program written and distributed by:
  20.  
  21.                Real Time eXecutives, Inc.  (RTX)
  22.                   686 South St.  P.O. Box 160
  23.                     Wrentham, MA 02093  USA
  24.                      Tel: (508) 384-7717
  25.  
  26. Feel free to pass this program on to others.  However, please pass on the
  27. original self-extraction program, RTXSCHED.EXE, instead of the individual
  28. files.  If you find this program useful and of value, a donation of $25.00
  29. would be greatly appreciated.  To become a registered user, send $45.00. 
  30. This entitles you to receive the next version of the program free of charge,
  31. when it becomes available. 
  32.  
  33. Real Time eXecutives, Inc. disclaims all warranties whether express or
  34. implied, including implied warranties of merchantability, fitness for a
  35. particular purpose, functionality, data integrity or protection.  See
  36. documentation for further disclaimers and information.
  37.  
  38. Thanks for your support.
  39.  
  40.  
  41.  
  42.                               OVERVIEW
  43.  
  44.  
  45. This program can be used to schedule the periodic execution of programs or
  46. batch files on the IBM/PC/XT/AT/PS2 and compatibles running DOS 2.x or
  47. greater.
  48.  
  49. Even though the program is similar in function and appearance to the DOS
  50. command processor ("COMMAND.COM"), it is not a replacement for it.  Instead
  51. it sits on top of the command processor and acts more like a pre-processor.
  52.  
  53. There are some important things that must be kept in mind:
  54.  
  55.      A.   First and most important, never load software from the
  56.           scheduler that will remain resident in memory (ie.
  57.           SIDEKICK, SUPERKEY, etc.).  Loading resident software
  58.           from the scheduler can trash the DOS memory allocation
  59.           tables leaving the user with no alternative but to
  60.           reboot the computer.  Make sure that all memory
  61.           resident programs that might be needed are loaded
  62.           before execution of the scheduler.  If a memory
  63.           resident program must be loaded after the scheduler has
  64.           been run, exit the scheduler using the /EXIT command,
  65.           then load the resident software and re-execute the scheduler.
  66.  
  67.      B.   Because it would be redundant, the execution of either
  68.           COMMAND.COM or SCHEDULE.EXE from within the scheduler
  69.           is not permitted.  If the user attempts to execute
  70.           either of these programs, the scheduler will reject the
  71.           request and issue an error message.
  72.  
  73.      C.   The files and programs used by the schedule program can
  74.           either reside in the default directory or in the DOS path.
  75.  
  76.  
  77.  
  78.                       SCHEDULE TABLE DEFINITION
  79.  
  80. The ASCII text file SCHEDULE.DAT is the file that the user will create or
  81. edit to define the execution times and command lines to be executed by the
  82. scheduler program.  This file can be created or edited using any ASCII text
  83. editor (ie.  Brief, PMATE, EDLIN etc.) and can reside either in the current
  84. directory or in the DOS path.  The schedule table is built from this file on
  85. initial execution of the program scheduler or by issuing the "/REBUILD"
  86. command (see below).
  87.  
  88. There are three fields in each record (text line), separated from each other
  89. by one or more spaces.  The first field is the time of day (since midnight
  90. last night) of the first or initial execution of the command line.  The
  91. second field is the time interval between executions and the third field is
  92. the command line to be executed.
  93.  
  94. The general format is:
  95.  
  96.      START_TIME  INTERVAL  COMMAND_LINE_TO_BE_EXECUTED
  97.  
  98. Times are specified as 1 to 3 integers separated by colons, in 24 hour
  99. format.
  100.  
  101. The first integer read will be considered the hours, the second the minutes
  102. and the third the seconds.  It is not necessary to enter all three integers.
  103. For example, if the desired start time is 11 PM, the user can simple enter
  104. 23.  If the interval time was ten minutes, the user could enter 00:10.  If
  105. the start time was 1 AM plus 10 seconds the user would have to enter
  106. 1:00:10.
  107.  
  108. The hour field can be greater than 24.  For example, if the desired execution
  109. interval is every 2 days, the user would enter a 48 for the time interval.
  110.  
  111. If the execution interval time is zero, the command line will be executed
  112. once and only once at the start time specified.  If the start time is
  113. specified greater than the current time, the command line will be executed
  114. once only at that time.  If the start time is less than the current time, the
  115. command line will be executed once only at the specified start time + 24
  116. hours.  After a "run once only" command has been executed, its entry will be
  117. removed from the schedule table.  It will not be removed from the
  118. SCHEDULE.DAT file.  The command line can be re-scheduled by re-executing the
  119. schedule program or by re-building the schedule table using the "/REBUILD"
  120. command.
  121.  
  122. If the first character in a schedule definition record is anything other than
  123. an ASCII digit (0 -9), the entry will be considered a comment and ignored.
  124. This will allow for the inclusion of comments in the schedule definition
  125. file.  The exception to this rule is the reserved word "NOW".  If "NOW" is
  126. entered for a start time, the command will be executed at program load (or
  127. any time the schedule table is rebuilt).  Examples of comment entries and the
  128. "NOW" execution, can be seen below in the definition file entry examples.
  129.  
  130. If the schedule definition file is not found or is empty, the scheduler will
  131. function properly but no commands will scheduled for execution.  The user
  132. will be notified if there are no table entries.
  133.  
  134. The following are examples of entries in the schedule definition file.  Note
  135. that the command line must be <= 127 characters and each field is separated
  136. by one or more spaces.
  137.  
  138.  
  139. Example 1:
  140. ----------
  141.  
  142. * Whenever the first character is not a digit, it is a comment line
  143. *
  144.  
  145.  
  146. Example 2:
  147. ----------
  148.  
  149. * Execute the program PROG1.COM every 10 minutes starting at
  150. * midnight, with command line arguments ARG1 to ARGn.
  151. *
  152. 00:00:00  00:10:00  PROG1 ARG1 ARG2 ... ARGn
  153.  
  154.  
  155. Example 3:
  156. ----------
  157.  
  158. * Execute the program PROG2.EXE every 1 hour and 1 minute starting
  159. * at 10:01:10 AM.
  160. *
  161. 10:01:10  1:01  PROG2
  162.  
  163.  
  164. Example 4:
  165. ----------
  166.  
  167. * Execute the internal command /HELP once and only once
  168. * at 2:11:32 PM.
  169. *
  170. 14:11:32  00:00:00  /help
  171.  
  172.  
  173. Example 5:
  174. ----------
  175.  
  176. * Execute the DOS command DIR once and only once on load (or rebuild)
  177. *
  178. NOW  00:00:00  DIR
  179.  
  180.  
  181. Example 6:
  182. ----------
  183.  
  184. * Execute the batch file JOB.BAT with the command line arguments ARG1
  185. * to ARGn once every 2 days starting at 12 AM
  186. *
  187. 12  48  JOB arg1 arg2 ... argn
  188.  
  189.  
  190.  
  191.                          SCHEDULER LOG FILE
  192.  
  193. If the /LOG function is activated (see below) then entries will be written to
  194. the file SCHEDULE.LOG.  The log file can either be in the current directory
  195. or in the DOS path.  If it is not found, it will be created in the current
  196. directory.  The user should be aware that the log file is never deleted by
  197. the program.  If the /LOG function is used extensively the file can grow very
  198. large.  It is up to the user to delete this file when appropriate.
  199.  
  200.  
  201.  
  202.                           INTERNAL COMMANDS
  203.  
  204. This is a list of the internal commands that can be entered on the SCHEDULE
  205. command line and a brief explanation of their function :
  206.  
  207.     /EXIT        - Exit the scheduler.
  208.     /HELP or "?" - Quick reference of commands.
  209.     /LIST        - List the current schedule table.
  210.     /REBUILD     - Rebuild the schedule table.
  211.     /LOG         - Set (or report) Log mode.
  212.     /SPACE       - Set (or report) Save Space mode
  213.     /DISABLE     - Disable schedule table checking.
  214.     /ENABLE      - Enable schedule table checking.
  215.     /FLAGS       - Display current flag settings.
  216.     /NOTICE      - Display shareware notice.
  217.  
  218. On the following pages we will explain in detail the function of each of
  219. these commands:
  220.  
  221.  
  222.  
  223.    Command : /EXIT
  224.  
  225.    Function : Exit from the scheduler.
  226.  
  227.      Entering "/EXIT" on the command line will exit the scheduler
  228.      program.
  229.  
  230.  
  231.  
  232.    Command : /HELP or "?"
  233.  
  234.    Function : Display a list of internal commands.
  235.  
  236.      This command is provided so that a "quick reference" list of the
  237.      internal commands is available on line to the user without having to
  238.      refer to the manual.
  239.  
  240.  
  241.  
  242.    Command : /LIST [PR]
  243.  
  244.    Function : List the current schedule table.
  245.  
  246.      This internal command will display a list of the current schedule
  247.      table.  If a hard copy of this list is desired, the user can enter the
  248.      command followed by "PR" (ie.  "/LIST PR").  This will send the output
  249.      list to the printer instead of the screen.
  250.  
  251.  
  252.  
  253.    Command : /REBUILD
  254.  
  255.    Function : Rebuild the schedule table.
  256.  
  257.      This internal command rebuilds the schedule table on line.  If the
  258.      schedule table needs to be changed, the user can edit the schedule file
  259.      and then enter "/REBUILD".  The current schedule table will be deleted
  260.      and a new table built from the file.
  261.  
  262.  
  263.  
  264.    Command : /LOG [=level] [ON] [OFF]
  265.  
  266.    Function : Log program execution in the log file.
  267.  
  268.      This internal command will set the log level and select output to the
  269.      log file.  If the log level is set to 1 (ie.  "/LOG=1") only the
  270.      scheduled executions will be logged.  If the log level is set to 2 or
  271.      greater, both the scheduled executions and the manual executions (user
  272.      typed command lines) will logged.  When a program execution is logged,
  273.      the time and date stamp, the execution request type ("MANUAL" or
  274.      "SCHEDULED"), and the command line will be written to the log file.  The
  275.      keyword OFF turns logging off.  The key word ON restores logging to the
  276.      level that it was set to before an OFF was issued.
  277.  
  278.  
  279.  
  280.    Command : /SPACE [ON] [OFF]
  281.  
  282.    Function : Set Save Space mode (or report current setting).
  283.  
  284.      This internal command will set the Save Space mode "ON" or "OFF".  If
  285.      the selected Save Space mode is "ON" the program will try to execute
  286.      commands as child processes before passing the command to the DOS
  287.      command handler.  This will save space as the command handler does not
  288.      always have to be loaded into memory.  The default mode is "OFF".
  289.  
  290.      <<WARNING>> If the selected Save Space mode is "ON", you can NOT
  291.      redirect or pipe the output of a program.  Mode "ON" should be selected
  292.      only if you have problems with not enough memory.
  293.  
  294.  
  295.  
  296.    Command : /DISABLE
  297.  
  298.    Function : Disables schedule table checking.
  299.  
  300.      In the normal operation of the scheduler, the program will check to see
  301.      if there is a scheduled program to execute and then check to see if you
  302.      are pressing keys on the keyboard.  If you are pressing keys, the
  303.      program will temporarily suspend the schedule table check, allowing you
  304.      to enter the entire command without interrupting you.  There is however
  305.      a 10 second timeout on key hits.  That is, if you wait more than 10
  306.      seconds, the program will go off and check again for a scheduled
  307.      program.  If you're like me, you may sometimes spend more than 10
  308.      seconds thinking before pressing another key, or maybe you want to write
  309.      down something that is displayed on the screen.  This internal command
  310.      forces the program to stop all schedule table checking, allowing you as
  311.      much time as you need.  A warning will be displayed with each prompt if
  312.      checking is disabled.
  313.  
  314.      ** Remember ** if you disable schedule table checking, you must re-
  315.      enable it or none of the scheduled programs will get executed.
  316.  
  317.  
  318.  
  319.    Command : /ENABLE
  320.  
  321.    Function : Enable schedule table checking after it has been
  322.               disabled.
  323.  
  324.      This internal command allows you to start up the schedule table checking
  325.      again, after it has been disabled.
  326.  
  327.  
  328.  
  329.    Command : /FLAGS
  330.  
  331.    Function : Display current flag settings.
  332.  
  333.      This internal command will display a list of the current flag settings.
  334.      These flags include:  Schedule checking, Save space, Debug, and Logging
  335.      mode.
  336.  
  337.  
  338.  
  339.    Command : /NOTICE
  340.  
  341.    Function : Display shareware notice.
  342.  
  343.      This internal command will display the shareware notice.
  344.